feat: Add custom model support with AWS credentials #2538
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implements support for custom models that bypass Builder ID authentication and use AWS credentials directly. This enables enterprise users to use Amazon Q CLI with their existing AWS authentication infrastructure. Features: - Custom model format: custom:<region>:<model-id> - Automatic mapping between Bedrock and Q Developer model IDs - AWS credentials chain support (ENV, Profile, IRSA, ECS, EC2) - Region extraction and configuration from model format - Clear display of custom model in chat UI Example usage: q chat --model "custom:us-east-1:us.anthropic.claude-3-5-sonnet-20241022-v2:0" q chat --model "custom:us-east-1:CLAUDE_3_7_SONNET_20250219_V1_0" 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Add unit tests for model parsing and mapping in model.rs - Add integration tests for CustomModelHandler in custom_model.rs - Create end-to-end test script for complete workflow testing - Add test documentation with coverage matrix - Fix test compilation issues in CI/CD Tests cover: - Bedrock to Q Developer model ID mapping - Custom model format parsing (custom:<region>:<model-id>) - Region extraction and validation - Authentication bypass for custom models - Environment variable setup - Debug trait implementation
Remove redux-cli from Cargo.toml workspace members as the crate doesn't exist in the repository, causing CI failures.
- Fix unused variable warning by prefixing with underscore - Replace map().unwrap_or() with is_some_and() per clippy recommendation - Add #[allow(dead_code)] for intentionally unused functions
Fix formatting issues to comply with project style guidelines: - Multi-line imports for tracing module - Remove trailing whitespace - Consistent spacing around code blocks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds support for custom models that bypass Builder ID authentication and use AWS credentials directly, enabling enterprise users to leverage Amazon Q CLI with their existing AWS authentication infrastructure.
Motivation
Enterprise users need to use Amazon Q CLI with:
Changes
Core Features
custom:<region>:<model-id>Technical Implementation
parse_custom_model()function to extract region and model IDCustomModelHandlerfor managing custom model logicUsage Examples
Bedrock-style model ID:
Q Developer model ID:
Set as default:
q settings chat.defaultModel "custom:us-east-1:CLAUDE_3_7_SONNET_20250219_V1_0"Testing
✅ Tested with both Bedrock and Q Developer model ID formats
✅ Verified AWS credentials chain authentication
✅ Confirmed region extraction and configuration
✅ Validated model ID mapping
✅ Tested interactive and non-interactive modes
Files Changed
crates/chat-cli/src/api_client/custom_model.rs- New custom model handlercrates/chat-cli/src/api_client/mod.rs- API client modificationscrates/chat-cli/src/cli/chat/cli/model.rs- Model parsing and mappingcrates/chat-cli/src/cli/chat/mod.rs- Chat session enhancementscrates/chat-cli/src/cli/mod.rs- Authentication bypass logicdocs/CUSTOM_MODELS.md- Comprehensive documentationBenefits
Backward Compatibility
✅ All existing functionality preserved
✅ Standard models continue to work as before
✅ Builder ID authentication still used for non-custom models
🤖 Generated with Claude Code